Skip to content

Add documentation for SBOM#676

Open
yogeshhegde wants to merge 4 commits intoTexasInstruments:masterfrom
yogeshhegde:sbom
Open

Add documentation for SBOM#676
yogeshhegde wants to merge 4 commits intoTexasInstruments:masterfrom
yogeshhegde:sbom

Conversation

@yogeshhegde
Copy link
Copy Markdown
Contributor

@yogeshhegde yogeshhegde commented Apr 16, 2026

feat(linux): Add how to guide for working with SBOMs
Add How to guide for working with SBOM's with sections

  • Generating SBOM in SPDX and CycloneDX format
  • Tools and references for Working with SBOM i.e visualizing, merging,
    modifying SBOMs

feat(linux): Add SBOM section to release notes
Add release artefacts SBOM information for AM64X,AM62X,AM62PX and AM62LX
devices.

Doc Link - https://yogeshhegde.github.io/processor-sdk-doc/processor-sdk-linux-AM62LX/esd/docs/master/linux/How_to_Guides/FAQ/How_to_work_with_SBOM.html

@github-actions
Copy link
Copy Markdown

New warnings found with rstcheck:

source/devices/AM62PX/linux/Release_Specific_Release_Notes.rst:43: (ERROR/3) Undefined substitution referenced: "SDK_FULL_NAME".
source/devices/AM62PX/linux/Release_Specific_Release_Notes.rst:43: (ERROR/3) Undefined substitution referenced: "SDK_DOWNLOAD_URL".
source/devices/AM62LX/linux/Release_Specific_Release_Notes.rst:43: (ERROR/3) Undefined substitution referenced: "SDK_FULL_NAME".
source/devices/AM62LX/linux/Release_Specific_Release_Notes.rst:43: (ERROR/3) Undefined substitution referenced: "SDK_DOWNLOAD_URL".
source/devices/AM64X/linux/Release_Specific_Release_Notes.rst:41: (ERROR/3) Undefined substitution referenced: "SDK_FULL_NAME".
source/devices/AM64X/linux/Release_Specific_Release_Notes.rst:41: (ERROR/3) Undefined substitution referenced: "SDK_DOWNLOAD_URL".
source/devices/AM62X/linux/Release_Specific_Release_Notes.rst:41: (ERROR/3) Undefined substitution referenced: "SDK_FULL_NAME".
source/devices/AM62X/linux/Release_Specific_Release_Notes.rst:41: (ERROR/3) Undefined substitution referenced: "SDK_DOWNLOAD_URL".
source/linux/How_to_Guides/FAQ/How_to_work_with_SBOM.rst:10: (ERROR/3) Unexpected indentation.

1 similar comment
@github-actions
Copy link
Copy Markdown

New warnings found with rstcheck:

source/devices/AM62PX/linux/Release_Specific_Release_Notes.rst:43: (ERROR/3) Undefined substitution referenced: "SDK_FULL_NAME".
source/devices/AM62PX/linux/Release_Specific_Release_Notes.rst:43: (ERROR/3) Undefined substitution referenced: "SDK_DOWNLOAD_URL".
source/devices/AM62LX/linux/Release_Specific_Release_Notes.rst:43: (ERROR/3) Undefined substitution referenced: "SDK_FULL_NAME".
source/devices/AM62LX/linux/Release_Specific_Release_Notes.rst:43: (ERROR/3) Undefined substitution referenced: "SDK_DOWNLOAD_URL".
source/devices/AM64X/linux/Release_Specific_Release_Notes.rst:41: (ERROR/3) Undefined substitution referenced: "SDK_FULL_NAME".
source/devices/AM64X/linux/Release_Specific_Release_Notes.rst:41: (ERROR/3) Undefined substitution referenced: "SDK_DOWNLOAD_URL".
source/devices/AM62X/linux/Release_Specific_Release_Notes.rst:41: (ERROR/3) Undefined substitution referenced: "SDK_FULL_NAME".
source/devices/AM62X/linux/Release_Specific_Release_Notes.rst:41: (ERROR/3) Undefined substitution referenced: "SDK_DOWNLOAD_URL".
source/linux/How_to_Guides/FAQ/How_to_work_with_SBOM.rst:10: (ERROR/3) Unexpected indentation.

@github-actions
Copy link
Copy Markdown

New warnings found with rstcheck:

source/devices/AM62PX/linux/Release_Specific_Release_Notes.rst:43: (ERROR/3) Undefined substitution referenced: "SDK_FULL_NAME".
source/devices/AM62PX/linux/Release_Specific_Release_Notes.rst:43: (ERROR/3) Undefined substitution referenced: "SDK_DOWNLOAD_URL".
source/devices/AM62LX/linux/Release_Specific_Release_Notes.rst:43: (ERROR/3) Undefined substitution referenced: "SDK_FULL_NAME".
source/devices/AM62LX/linux/Release_Specific_Release_Notes.rst:43: (ERROR/3) Undefined substitution referenced: "SDK_DOWNLOAD_URL".
source/devices/AM64X/linux/Release_Specific_Release_Notes.rst:41: (ERROR/3) Undefined substitution referenced: "SDK_FULL_NAME".
source/devices/AM64X/linux/Release_Specific_Release_Notes.rst:41: (ERROR/3) Undefined substitution referenced: "SDK_DOWNLOAD_URL".
source/devices/AM62X/linux/Release_Specific_Release_Notes.rst:41: (ERROR/3) Undefined substitution referenced: "SDK_FULL_NAME".
source/devices/AM62X/linux/Release_Specific_Release_Notes.rst:41: (ERROR/3) Undefined substitution referenced: "SDK_DOWNLOAD_URL".

@github-actions
Copy link
Copy Markdown

New warnings found with rstcheck:

source/linux/How_to_Guides/FAQ/How_to_work_with_SBOM.rst:10: (ERROR/3) "list-table" widths do not match the number of columns in table (4).

Comment thread source/devices/AM62LX/linux/Release_Specific_Release_Notes.rst
Comment thread source/linux/How_to_Guides/FAQ/How_to_work_with_SBOM.rst
Add release artefacts SBOM information for AM64X,AM62X,AM62PX and AM62LX
devices.

Signed-off-by: Yogesh Hegde <y-hegde@ti.com>
@yogeshhegde yogeshhegde force-pushed the sbom branch 2 times, most recently from 9338c00 to b9ad5de Compare April 16, 2026 13:05
Comment thread source/linux/How_to_Guides/FAQ/How_to_work_with_SBOM.rst
Comment thread source/linux/How_to_Guides/FAQ/How_to_work_with_SBOM.rst Outdated
Comment thread source/linux/How_to_Guides/FAQ/How_to_work_with_SBOM.rst Outdated
Comment thread source/linux/How_to_Guides/FAQ/How_to_work_with_SBOM.rst Outdated
1. Start with the build instructions in :ref:`Processor SDK - Building the SDK with Yocto <building-the-sdk-with-yocto>`
2. After cloning ``oe-layersetup``, uncomment the ``meta-cyclonedx`` line in
the layer configuration file, for example:

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Any reasons we aren't pushing a new oe-config file to oe-layersetup dedicated for SBOMs?
We can avoid the following manual local changes & improve the user experience

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here are few reasons,

  1. CycloneDX SBOM is not default format for SBOM, but there might be some users who want to use the format.
  2. Duplication of oe-config, there are 4 oe-config for 12.00.00 release, creating new oe-config just for cyclonedx would take that number to 8 since we have to give each oe-config with SPDX and CycloneDX SBOM generation.
  3. 8 oe-config will lead to more user confusion instead of improving user experience because for users who just want sane defaults they will be confused which oe-config to use.
  4. oe-layersetup does not allow us to include files / config fragments, while kas (yaml) and repo (xml) both have include files feature where we can create fragments and user can include/exclude fragments enabling/disabling features. This would simplify both maintenance and improve user experience.

With these constraints, I believe this is the best course, since it is just uncommenting a line for the user and they also see less oe-configs.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree with this approach for the 12.0 release. Since we are still in the evaluation phase for SBOMs, it makes sense to avoid config bloat and keep the user experience simple for now.

However, SBOMs are the way to go in the future. Moving forward, we should look into how we can incorporate them into the default SDK build flow...

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

SBOM (in SPDX format) is in default SDK build flow. But if the user wants a CycloneDX format for SBOM then user has to use the non-default SDK build flow.

It depends on the Adoption of SPDX and CycloneDX formats. The format that has higher Adoption will be default SDK build flow while the one with the lower adoption will be the non-default one and will require additional steps. Currently SPDX has higher Adoption, yet we have the option of CycloneDX to users who want it.

Comment thread source/linux/How_to_Guides/FAQ/How_to_work_with_SBOM.rst
Add How to guide for working with SBOM's with sections
* Generating SBOM in SPDX and CycloneDX format
* Tools and references for Working with SBOM i.e visualizing, merging,
modifying SBOMs

Signed-off-by: Yogesh Hegde <y-hegde@ti.com>
Add link to working with SBOM in release specific section

Signed-off-by: Yogesh Hegde <y-hegde@ti.com>
Add release artefacts SBOM information to release notes for AM62DX
device.

Signed-off-by: Yogesh Hegde <y-hegde@ti.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

8 participants